Skip to main content
POST
/
v1
/
shipping
/
retailers
/
{id}
/
identifiers
Create Retailer Identifier
curl --request POST \
  --url https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/identifiers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qualifier": "duns",
  "value": "123456789",
  "qualifier_x12": "01",
  "label": "Primary EDI DUNS",
  "is_primary": true,
  "notes": "Created from SPS onboarding kit."
}
'
{
  "resource": {
    "type": "<string>",
    "id": 1
  },
  "meta": {
    "processing_time": 123
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
id
integer<int32>
required

The id of the parent Retailer.

Required range: x >= 1

Body

application/json

An object conforming to the RetailerIdentifier schema to be created.

A RetailerIdentifier represents an EDI / trading-partner identifier attached to a Retailer (e.g. DUNS, GLN, SPS Trading Partner ID).

​
qualifier
enum<string>
required

Identifier qualifier kind.

Available options:
duns,
duns_plus_4,
gln,
isa,
gs,
as2,
retailer_vendor_number,
sps_trading_partner_id,
custom
Example:

"duns"

​
value
string
required

Identifier value. Must be unique within (merchant, qualifier, value).

Required string length: 1 - 64
Example:

"123456789"

​
qualifier_x12
string | null

Optional X12 numeric qualifier code.
Optional Field

Maximum string length: 4
Example:

"01"

​
label
string | null

Optional human-readable label.

Maximum string length: 128
Example:

"Primary EDI DUNS"

​
is_primary
boolean
default:false

Whether this identifier is marked primary. Staff-managed; siblings are not auto-unset.

Example:

true

​
notes
string | null

Optional freeform notes.
Optional Field

Example:

"Created from SPS onboarding kit."

​
retailer
RetailerRef · object

Parent Retailer reference. Set from the path; cannot be changed.

Response

Created - The resource was created successfully.

​
resource
object

An object describing the resource that was created.

​
meta
object